@uppy/companion-client

What is @uppy/companion-client?

@uppy/companion-client is a client-side library for Uppy, a modular file uploader for web browsers. It allows you to interact with Uppy Companion, a server-side component that handles file uploads from various sources such as local disk, remote URLs, and cloud services like Google Drive, Dropbox, and Instagram.

What are @uppy/companion-client's main functionalities?

Upload Files

This feature allows you to upload files to a specified endpoint using the Companion server. The code sample demonstrates how to upload a file named 'example.txt' to a Companion server.

const { uploadFile } = require('@uppy/companion-client');

const file = new File(['content'], 'example.txt', { type: 'text/plain' });

uploadFile(file, {
  endpoint: 'https://your-companion-server.com/upload',
  fieldName: 'file'
}).then(response => {
  console.log('File uploaded successfully:', response);
}).catch(error => {
  console.error('Error uploading file:', error);
});

Generate Pre-signed URLs

This feature allows you to generate pre-signed URLs for uploading files directly to cloud storage services like Amazon S3. The code sample demonstrates how to generate a pre-signed URL for a file named 'example.txt'.

const { getPreSignedUrl } = require('@uppy/companion-client');

getPreSignedUrl('https://your-companion-server.com/s3', {
  filename: 'example.txt',
  contentType: 'text/plain'
}).then(response => {
  console.log('Pre-signed URL:', response.url);
}).catch(error => {
  console.error('Error generating pre-signed URL:', error);
});

List Files

This feature allows you to list files from a specified source, such as Google Drive or Dropbox, using the Companion server. The code sample demonstrates how to list files from Google Drive.

const { list } = require('@uppy/companion-client');

list('https://your-companion-server.com/drive').then(response => {
  console.log('Files:', response.items);
}).catch(error => {
  console.error('Error listing files:', error);
});

Other packages similar to @uppy/companion-client

tus-js-client

tus-js-client is a client-side library for the tus resumable upload protocol. It allows you to upload large files in chunks, resume interrupted uploads, and handle network issues. Unlike @uppy/companion-client, which is designed to work with Uppy and its Companion server, tus-js-client focuses on resumable uploads and can be used independently.

fine-uploader

Fine Uploader is a JavaScript library for file uploads that supports multiple file selection, drag-and-drop, and resumable uploads. It provides a comprehensive set of features for file uploading, including support for various cloud storage services. Compared to @uppy/companion-client, Fine Uploader offers a more extensive set of features but may require more configuration.

dropzone

Dropzone is a JavaScript library that provides drag-and-drop file uploads with image previews. It is easy to set up and use, making it a popular choice for simple file upload needs. While Dropzone offers basic file upload functionality, it lacks the advanced features and integrations provided by @uppy/companion-client.

README

@uppy/companion-client

Client library for communication with Companion. Intended for use in Uppy plugins.

Uppy is being developed by the folks at Transloadit, a versatile file encoding service.

Example

import Uppy from '@uppy/core'
import { Provider, RequestClient, Socket } from '@uppy/companion-client'

const uppy = new Uppy()

const client = new RequestClient(uppy, {
  companionUrl: 'https://uppy.mywebsite.com/',
})
client.get('/drive/list').then(() => {})

const provider = new Provider(uppy, {
  companionUrl: 'https://uppy.mywebsite.com/',
  provider: providerPluginInstance,
})
provider.checkAuth().then(() => {})

const socket = new Socket({ target: 'wss://uppy.mywebsite.com/' })
socket.on('progress', () => {})

Installation

Unless you are writing a custom provider plugin, you do not need to install this.

$ npm install @uppy/companion-client

Documentation

Documentation for this plugin can be found on the Uppy website.

License

The MIT License.

Changelog

4.1.1

Released: 2024-08-15

| Package | Version | Package | Version | | ---------------------- | ------- | ---------------------- | ------- | | @uppy/aws-s3 | 4.0.3 | @uppy/provider-views | 4.0.1 | | @uppy/companion | 5.0.5 | @uppy/status-bar | 4.0.2 | | @uppy/companion-client | 4.0.1 | @uppy/transloadit | 4.0.2 | | @uppy/core | 4.1.1 | @uppy/tus | 4.0.1 | | @uppy/dashboard | 4.0.3 | @uppy/utils | 6.0.2 | | @uppy/drag-drop | 4.0.2 | @uppy/vue | 2.0.1 | | @uppy/file-input | 4.0.1 | uppy | 4.1.1 | | @uppy/image-editor | 3.0.1 | | |

• @uppy/transloadit: fix issue with allowMultipleUploadBatches (Mikael Finstad / #5400)
• meta: Bump elliptic from 6.5.5 to 6.5.7 (dependabot[bot] / #5410)
• meta: add back patch for p-queue (Antoine du Hamel / #5409)
• @uppy/transloadit: fix many lurking TypeError (Mikael Finstad / #5399)
• docs: improve corsOrigins documentation (Mikael Finstad / #5390)
• docs: add ViewEncapsulation to Angular example (Aaron Russell / #5395)
• @uppy/companion: fix code for custom providers (Mikael Finstad / #5398)
• docs: add note about throwing in cancelAll and destroy() (Mikael Finstad / #5408)
• meta: Bump docker/login-action from 3.2.0 to 3.3.0 (dependabot[bot] / #5372)
• meta: Bump docker/setup-qemu-action from 3.1.0 to 3.2.0 (dependabot[bot] / #5370)
• docs: make hosted Companion more clear (Merlijn Vos / #5394)
• meta: Bump docker/build-push-action from 6.4.1 to 6.6.1 (dependabot[bot] / #5403)
• meta: bump p-queue to latest, remove patch (Mikael Finstad / #5391)
• meta: enforce .ts extension for relative import types (Antoine du Hamel / #5393)
• @uppy/tus: Fix onShouldRetry type signature (Trent Nadeau / #5387)
• @uppy/dashboard,@uppy/drag-drop,@uppy/file-input: Transform the accept prop into a string everywhere (Evgenia Karunus / #5380)
• docs: fix getTemporarySecurityCredentials in aws-s3 (Merlijn Vos / #5363)